'\" t
.\"     Title: flume
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: 11/09/2010
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "FLUME" "1" "11/09/2010" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
flume \- a distributed, reliable, scalable, near\-realtime log collection system\&.
.SH "SYNOPSIS"
.sp
\fBflume\fR COMMAND [\fIOPTIONS\fR]
.SH "DESCRIPTION"
.sp
The flume(1) command has subcommands to execute different parts of the Flume system\&. The main subcommands are node, master, and shell\&.
.SH "COMMANDS"
.PP
\fBdump <source>\fR
.RS 4
Starts a one shot Flume daemon that outputs data to the console\&.
.RE
.PP
\fBnode\fR
.RS 4
Starts a Flume node daemon\&. The node is run with the watchdog program and cannot be used interactively\&. See flume\-node for more details\&.
.RE
.PP
\fBnode_nowatch\fR
.RS 4
Starts a Flume node daemon\&. The node is run without the watchdog program, and can be used interactively\&. See flume\-node for more details\&.
.RE
.PP
\fBmaster\fR
.RS 4
Starts a Flume master daemon\&. This runs the master with a watchdog program\&. There can only be one master running on a node\&. See flume\-mater for more details\&.
.RE
.PP
\fBshell\fR
.RS 4
Starts the Flume shell\&. See flume\-shell for more details\&.
.RE
.PP
\fBclass <classname>\fR
.RS 4
Executes the main program in the specified classname with the Flume environment settings\&.
.RE
.PP
\fBclasspath\fR
.RS 4
Dumps the java classpath used for when Flume programs are run\&.
.RE
.PP
\fBversion\fR
.RS 4
Dumps the Flume version and build hash\&.
.RE
.SH "EXIT STATUS"
.PP
\fB0\fR
.RS 4
Success
.RE
.PP
\fB1\fR
.RS 4
Failure (syntax or usage error; configuration error; document processing failure; unexpected error)\&.
.RE
.SH "ENVIRONMENT"
.PP
\fBFLUME_PID_DIR\fR
.RS 4
The directory where a Flume node or Flume master will drop pid files corresponding to the daemon process\&. Default is
/tmp/flumemaster\&.pid
when run as user and
/var/run/flume/flumemaster\&.pid
when run as a daemon\&.
.RE
.PP
\fBFLUME_CLASSPATH\fR
.RS 4
The custom java classpath environment variable additions you want Flume to run with\&. These values are prepended to the normal Flume generated CLASSPATH\&. WARNING: The
flume
script overwrites the standard CLASSPATH when it is executed\&. The default contains nothing\&.
.RE
.PP
\fBFLUME_LOG_DIR\fR
.RS 4
The directory where debugging logs generated by the Flume node or Flume master are written\&. The default is
$FLUME_HOME/logs
if run as a user, and
/var/log/flume/
if run as a daemon\&.
.RE
.PP
\fBFLUME_LOGFILE\fR
.RS 4
This sets the suffix for the logfiles generated by Flume node or Flume master\&.
.RE
.PP
\fBFLUME_ROOT_LOGGER\fR
.RS 4
The log4j logging setting for the executing command\&. By default it is "INFO,console"\&.
.RE
.PP
\fBZOOKEEPER_ROOT_LOGGER\fR
.RS 4
The log4j logging setting for a master\(cqs embedded Zookeeper server\(cqs logs\&. By default it is "ERROR,console"\&.
.RE
.PP
\fBWATCHDOG_ROOT_LOGGER\fR
.RS 4
The log4j logging setting for the logging the watchdog that wraps Flume nodes and Flume masters generates\&. By default it is "INFO,console"\&.
.RE
.PP
\fBFLUME_CONF_DIR\fR
.RS 4
The directory where the
flume\-site\&.xml
and
flume\-conf\&.xml
files Flume node and Flume master will use reside\&. This defaults to
\&./conf
if a
\&./conf/flume\-conf\&.xml
file is found, or to
/etc/flume/conf/
if it
flume\-conf\&.xml
is found there\&.
.RE
.PP
\fBHADOOP_HOME\fR
.RS 4
The directory where Hadoop jars are expected to be found\&. If not specified it will use jars found in
/usr/lib/hadoop
or
\&./lib/\&.
.RE
.PP
\fBFLUME_DEVMODE\fR
.RS 4
If this value is set to "true" the
\&./libbuild
jars which include ant jars required to compile JSP servlets will be included in the CLASSPATH\&.
.RE
.PP
\fBFLUME_VERBOSE\fR
.RS 4
If this is toggled, the Flume script will print out the command line being executed\&.
.RE
.PP
\fBFLUME_VERBOSE_JAVA\fR
.RS 4
If FLUME_VERBOSE is toggled, toggling this value will also add the "\-verbose" flag to the JVM running Flume\&.
.RE
.SH "AUTHOR"
.sp
See the Contributors site here: http://wiki\&.github\&.com/cloudera/flume/Contributors
.SH "RESOURCES"
.sp
Github web site and code repository: http://github\&.com/cloudera/flume/
.sp
Flume User guide: http://archive\&.cloudera\&.com/cdh/3/flume/UserGuide\&.html
.sp
Flume Cookbook: http://archive\&.cloudera\&.com/cdh/3/flume/Cookbook\&.html
.SH "COPYING"
.sp
Copyright (C) 2009\-2010 Cloudera, Inc\&.
.SH "SEE ALSO"
.sp
.if n \{\
.RS 4
.\}
.nf
flume(1), flume\-master(1), flume\-node(1), flume\-shell(1)
.fi
.if n \{\
.RE
.\}
